IRIX Base Documentation 1998 November/IRIX 6.5.2 Base Documentation November 1998.img/usr/share/catman/u_man/cat3/Tk/scrollbar.z/scrollbar

Text File | 1998-10-30 | 24KB | 463 lines

ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))                                                  ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))



NNNNAAAAMMMMEEEE
     scrollbar - Create and manipulate scrollbar widgets

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     ssssccccrrrroooollllllllbbbbaaaarrrr _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?

SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS
     aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd  hhhhiiiigggghhhhlllliiiigggghhhhttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd  oooorrrriiiieeeennnntttt              ttttaaaakkkkeeeeFFFFooooccccuuuussss     |
     bbbbaaaacccckkkkggggrrrroooouuuunnnndddd        hhhhiiiigggghhhhlllliiiigggghhhhttttCCCCoooolllloooorrrr       rrrreeeelllliiiieeeeffff              ttttrrrroooouuuugggghhhhCCCCoooolllloooorrrr   |
     bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh       hhhhiiiigggghhhhlllliiiigggghhhhttttTTTThhhhiiiicccckkkknnnneeeessssssss   rrrreeeeppppeeeeaaaattttDDDDeeeellllaaaayyyy                       |
     ccccuuuurrrrssssoooorrrr            jjjjuuuummmmpppp                 rrrreeeeppppeeeeaaaattttIIIInnnntttteeeerrrrvvvvaaaallll

     See the ``options'' manual entry for details on the standard options.

WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS
     Name:           aaaaccccttttiiiivvvveeeeRRRReeeelllliiiieeeeffff
     Class:          AAAAccccttttiiiivvvveeeeRRRReeeelllliiiieeeeffff
     Command-Line Switch:----aaaaccccttttiiiivvvveeeerrrreeeelllliiiieeeeffff

          Specifies the relief to use when displaying the element that is     |
          active, if any.  Elements other than the active element are always  |
          displayed with a raised relief.

     Name:           ccccoooommmmmmmmaaaannnndddd
     Class:          CCCCoooommmmmmmmaaaannnndddd
     Command-Line Switch:----ccccoooommmmmmmmaaaannnndddd

          Specifies the prefix of a Tcl command to invoke to change the view
          in the widget associated with the scrollbar.  When a user requests a
          view change by manipulating the scrollbar, a Tcl command is invoked.
          The actual command consists of this option followed by additional   |
          information as described later.

     Name:           eeeelllleeeemmmmeeeennnnttttBBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh
     Class:          BBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh
     Command-Line Switch:----eeeelllleeeemmmmeeeennnnttttbbbboooorrrrddddeeeerrrrwwwwiiiiddddtttthhhh

          Specifies the width of borders drawn around the internal elements of|
          the scrollbar (the two arrows and the slider).  The value may have  |
          any of the forms acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss.  If this value is less |
          than zero, the value of the bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh option is used in its place.

     Name:           wwwwiiiiddddtttthhhh
     Class:          WWWWiiiiddddtttthhhh
     Command-Line Switch:----wwwwiiiiddddtttthhhh

          Specifies the desired narrow dimension of the scrollbar window, not
          including 3-D border, if any.  For vertical scrollbars this will be
          the width and for horizontal scrollbars this will be the height.
          The value may have any of the forms acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss.





                                                                        PPPPaaaaggggeeee 1111






ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))                                                  ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))



DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     The ssssccccrrrroooollllllllbbbbaaaarrrr command creates a new window (given by the _p_a_t_h_N_a_m_e
     argument) and makes it into a scrollbar widget.  Additional options,
     described above, may be specified on the command line or in the option
     database to configure aspects of the scrollbar such as its colors,
     orientation, and relief.  The ssssccccrrrroooollllllllbbbbaaaarrrr command returns its _p_a_t_h_N_a_m_e
     argument.  At the time this command is invoked, there must not exist a
     window named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist.

     A scrollbar is a widget that displays two arrows, one at each end of the
     scrollbar, and a _s_l_i_d_e_r in the middle portion of the scrollbar.  It
     provides information about what is visible in an _a_s_s_o_c_i_a_t_e_d _w_i_n_d_o_w that
     displays an document of some sort (such as a file being edited or a
     drawing).  The position and size of the slider indicate which portion of
     the document is visible in the associated window.  For example, if the
     slider in a vertical scrollbar covers the top third of the area between
     the two arrows, it means that the associated window displays the top
     third of its document.

     Scrollbars can be used to adjust the view in the associated window by
     clicking or dragging with the mouse.  See the BINDINGS section below for
     details.


EEEELLLLEEEEMMMMEEEENNNNTTTTSSSS
     A scrollbar displays five elements, which are referred to in the widget  |
     commands for the scrollbar:

     aaaarrrrrrrroooowwww1111    The top or left arrow in the scrollbar.

     ttttrrrroooouuuugggghhhh1111   The region between the slider and aaaarrrrrrrroooowwww1111.

     sssslllliiiiddddeeeerrrr    The rectangle that indicates what is visible in the associated
               widget.

     ttttrrrroooouuuugggghhhh2222   The region between the slider and aaaarrrrrrrroooowwww2222.

     aaaarrrrrrrroooowwww2222    The bottom or right arrow in the scrollbar.


WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD
     The ssssccccrrrroooollllllllbbbbaaaarrrr command creates a new Tcl command whose name is _p_a_t_h_N_a_m_e.
     This command may be used to invoke various operations on the widget.  It
     has the following general form:

          _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?

     _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the command.  The
     following commands are possible for scrollbar widgets:






                                                                        PPPPaaaaggggeeee 2222






ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))                                                  ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))



     _p_a_t_h_N_a_m_e aaaaccccttttiiiivvvvaaaatttteeee ?_e_l_e_m_e_n_t?
          Marks the element indicated by _e_l_e_m_e_n_t as active, which causes it to|
          be displayed as specified by the aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd and aaaaccccttttiiiivvvveeeeRRRReeeelllliiiieeeeffff  |
          options.  The only element values understood by this command are    |
          aaaarrrrrrrroooowwww1111, sssslllliiiiddddeeeerrrr, or aaaarrrrrrrroooowwww2222.  If any other value is specified then no |
          element of the scrollbar will be active.  If _e_l_e_m_e_n_t is not         |
          specified, the command returns the name of the element that is      |
          currently active, or an empty string if no element is active.

     _p_a_t_h_N_a_m_e ccccggggeeeetttt _o_p_t_i_o_n
          Returns the current value of the configuration option given by      |
          _o_p_t_i_o_n.  _O_p_t_i_o_n may have any of the values accepted by the ssssccccrrrroooollllllllbbbbaaaarrrr|
          command.

     _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
          Query or modify the configuration options of the widget.  If no
          _o_p_t_i_o_n is specified, returns a list describing all of the available
          options for _p_a_t_h_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the
          format of this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
          the command returns a list describing the one named option (this
          list will be identical to the corresponding sublist of the value
          returned if no _o_p_t_i_o_n is specified).  If one or more _o_p_t_i_o_n-_v_a_l_u_e
          pairs are specified, then the command modifies the given widget
          option(s) to have the given value(s);  in this case the command
          returns an empty string.  _O_p_t_i_o_n may have any of the values accepted
          by the ssssccccrrrroooollllllllbbbbaaaarrrr command.

     _p_a_t_h_N_a_m_e ddddeeeellllttttaaaa _d_e_l_t_a_X _d_e_l_t_a_Y
          Returns a real number indicating the fractional change in the       |
          scrollbar setting that corresponds to a given change in slider      |
          position.  For example, if the scrollbar is horizontal, the result  |
          indicates how much the scrollbar setting must change to move the    |
          slider _d_e_l_t_a_X pixels to the right (_d_e_l_t_a_Y is ignored in this case). |
          If the scrollbar is vertical, the result indicates how much the     |
          scrollbar setting must change to move the slider _d_e_l_t_a_Y pixels down.|
          The arguments and the result may be zero or negative.

     _p_a_t_h_N_a_m_e ffffrrrraaaaccccttttiiiioooonnnn _x _y
          Returns a real number between 0 and 1 indicating where the point
          given by _x and _y lies in the trough area of the scrollbar.  The
          value 0 corresponds to the top or left of the trough, the value 1
          corresponds to the bottom or right, 0.5 corresponds to the middle,
          and so on.  _X and _y must be pixel coordinates relative to the
          scrollbar widget.  If _x and _y refer to a point outside the trough,
          the closest point in the trough is used.

     _p_a_t_h_N_a_m_e ggggeeeetttt
          Returns the scrollbar settings in the form of a list whose elements
          are the arguments to the most recent sssseeeetttt widget command.






                                                                        PPPPaaaaggggeeee 3333






ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))                                                  ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))



     _p_a_t_h_N_a_m_e iiiiddddeeeennnnttttiiiiffffyyyy _x _y
          Returns the name of the element under the point given by _x and _y
          (such as aaaarrrrrrrroooowwww1111), or an empty string if the point does not lie in
          any element of the scrollbar.  _X and _y must be pixel coordinates
          relative to the scrollbar widget.

     _p_a_t_h_N_a_m_e sssseeeetttt _f_i_r_s_t _l_a_s_t
          This command is invoked by the scrollbar's associated widget to tell
          the scrollbar about the current view in the widget.  The command
          takes two arguments, each of which is a real fraction between 0 and
          1.  The fractions describe the range of the document that is visible
          in the associated widget.  For example, if _f_i_r_s_t is 0.2 and _l_a_s_t is
          0.4, it means that the first part of the document visible in the
          window is 20% of the way through the document, and the last visible
          part is 40% of the way through.


SSSSCCCCRRRROOOOLLLLLLLLIIIINNNNGGGG CCCCOOOOMMMMMMMMAAAANNNNDDDDSSSS
     When the user interacts with the scrollbar, for example by dragging the
     slider, the scrollbar notifies the associated widget that it must change
     its view.  The scrollbar makes the notification by evaluating a Tcl
     command generated from the scrollbar's ----ccccoooommmmmmmmaaaannnndddd option.  The command may
     take any of the following forms.  In each case, _p_r_e_f_i_x is the contents of
     the ----ccccoooommmmmmmmaaaannnndddd option, which usually has a form like ....tttt yyyyvvvviiiieeeewwww

     _p_r_e_f_i_x mmmmoooovvvveeeettttoooo _f_r_a_c_t_i_o_n
          _F_r_a_c_t_i_o_n is a real number between 0 and 1.  The widget should adjust
          its view so that the point given by _f_r_a_c_t_i_o_n appears at the
          beginning of the widget.  If _f_r_a_c_t_i_o_n is 0 it refers to the
          beginning of the document.  1.0 refers to the end of the document,
          0.333 refers to a point one-third of the way through the document,
          and so on.

     _p_r_e_f_i_x ssssccccrrrroooollllllll _n_u_m_b_e_r uuuunnnniiiitttt
          The widget should adjust its view by _n_u_m_b_e_r units.  The units are
          defined in whatever way makes sense for the widget, such as
          characters or lines in a text widget.  _N_u_m_b_e_r is either 1, which
          means one unit should scroll off the top or left of the window, or
          -1, which means that one unit should scroll off the bottom or right
          of the window.

     _p_r_e_f_i_x ssssccccrrrroooollllllll _n_u_m_b_e_r ppppaaaaggggeeee
          The widget should adjust its view by _n_u_m_b_e_r pages.  It is up to the
          widget to define the meaning of a page;  typically it is slightly
          less than what fits in the window, so that there is a slight overlap
          between the old and new views.  _N_u_m_b_e_r is either 1, which means the
          next page should become visible, or -1, which means that the
          previous page should become visible.







                                                                        PPPPaaaaggggeeee 4444






ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))                                                  ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))



OOOOLLLLDDDD CCCCOOOOMMMMMMMMAAAANNNNDDDD SSSSYYYYNNNNTTTTAAAAXXXX
     In versions of Tk before 4.0, the sssseeeetttt and ggggeeeetttt widget commands used a
     different form.  This form is still supported for backward compatibility,
     but it is deprecated.  In the old command syntax, the sssseeeetttt widget command
     has the following form:

     _p_a_t_h_N_a_m_e sssseeeetttt _t_o_t_a_l_U_n_i_t_s _w_i_n_d_o_w_U_n_i_t_s _f_i_r_s_t_U_n_i_t _l_a_s_t_U_n_i_t
          In this form the arguments are all integers.  _T_o_t_a_l_U_n_i_t_s gives the
          total size of the object being displayed in the associated widget.
          The meaning of one unit depends on the associated widget;  for
          example, in a text editor widget units might correspond to lines of
          text.  _W_i_n_d_o_w_U_n_i_t_s indicates the total number of units that can fit
          in the associated window at one time.  _F_i_r_s_t_U_n_i_t and _l_a_s_t_U_n_i_t give
          the indices of the first and last units currently visible in the
          associated window (zero corresponds to the first unit of the
          object).

     Under the old syntax the ggggeeeetttt widget command returns a list of four
     integers, consisting of the _t_o_t_a_l_U_n_i_t_s, _w_i_n_d_o_w_U_n_i_t_s, _f_i_r_s_t_U_n_i_t, and
     _l_a_s_t_U_n_i_t values from the last sssseeeetttt widget command.

     The commands generated by scrollbars also have a different form when the
     old syntax is being used:

     _p_r_e_f_i_x _u_n_i_t
          _U_n_i_t is an integer that indicates what should appear at the top or
          left of the associated widget's window.  It has the same meaning as
          the _f_i_r_s_t_U_n_i_t and _l_a_s_t_U_n_i_t arguments to the sssseeeetttt widget command.

     The most recent sssseeeetttt widget command determines whether or not to use the
     old syntax.  If it is given two real arguments then the new syntax will
     be used in the future, and if it is given four integer arguments then the
     old syntax will be used.


BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS
     Tk automatically creates class bindings for scrollbars that give them the|
     following default behavior.  If the behavior is different for vertical   |
     and horizontal scrollbars, the horizontal behavior is described in       |
     parentheses.

     [1]  Pressing button 1 over aaaarrrrrrrroooowwww1111 causes the view in the associated
          widget to shift up (left) by one unit so that the document appears
          to move down (right) one unit.  If the button is held down, the
          action auto-repeats.

     [2]  Pressing button 1 over ttttrrrroooouuuugggghhhh1111 causes the view in the associated
          widget to shift up (left) by one screenful so that the document
          appears to move down (right) one screenful.  If the button is held
          down, the action auto-repeats.





                                                                        PPPPaaaaggggeeee 5555






ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))                                                  ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))



     [3]  Pressing button 1 over the slider and dragging causes the view to
          drag with the slider.  If the jjjjuuuummmmpppp option is true, then the view
          doesn't drag along with the slider;  it changes only when the mouse
          button is released.

     [4]  Pressing button 1 over ttttrrrroooouuuugggghhhh2222 causes the view in the associated
          widget to shift down (right) by one screenful so that the document
          appears to move up (left) one screenful.  If the button is held
          down, the action auto-repeats.

     [5]  Pressing button 1 over aaaarrrrrrrroooowwww2222 causes the view in the associated
          widget to shift down (right) by one unit so that the document
          appears to move up (left) one unit.  If the button is held down, the
          action auto-repeats.

     [6]  All of the above actions may be invoked with button 2 as well as
          with button 1.

     [7]  If button 1 is pressed with the Control key down, then if the mouse
          is over aaaarrrrrrrroooowwww1111 or ttttrrrroooouuuugggghhhh1111 the view changes to the very top (left) of
          the document;  if the mouse is over aaaarrrrrrrroooowwww2222 or ttttrrrroooouuuugggghhhh2222 the view
          changes to the very bottom (right) of the document;  if the mouse is
          anywhere else then the button press has no effect.

     [8]  In vertical scrollbars the Up and Down keys have the same behavior
          as mouse clicks over aaaarrrrrrrroooowwww1111 and aaaarrrrrrrroooowwww2222, respectively.  In horizontal
          scrollbars these keys have no effect.

     [9]  In vertical scrollbars Control-Up and Control-Down have the same
          behavior as mouse clicks over ttttrrrroooouuuugggghhhh1111 and ttttrrrroooouuuugggghhhh2222, respectively.  In
          horizontal scrollbars these keys have no effect.

     [10] In horizontal scrollbars the Up and Down keys have the same behavior
          as mouse clicks over aaaarrrrrrrroooowwww1111 and aaaarrrrrrrroooowwww2222, respectively.  In vertical
          scrollbars these keys have no effect.

     [11] In horizontal scrollbars Control-Up and Control-Down have the same
          behavior as mouse clicks over ttttrrrroooouuuugggghhhh1111 and ttttrrrroooouuuugggghhhh2222, respectively.  In
          vertical scrollbars these keys have no effect.

     [12] The Prior and Next keys have the same behavior as mouse clicks over
          ttttrrrroooouuuugggghhhh1111 and ttttrrrroooouuuugggghhhh2222, respectively.

     [13] The Home key adjusts the view to the top (left edge) of the
          document.

     [14] The End key adjusts the view to the bottom (right edge) of the
          document.







                                                                        PPPPaaaaggggeeee 6666






ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))                                                  ssssccccrrrroooollllllllbbbbaaaarrrr((((3333TTTTkkkk))))



KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
     scrollbar, widget





















































                                                                        PPPPaaaaggggeeee 7777